SERV Alert EAPI
TA Data Definition
Listed below are the fields of the request body that is sent to the callback URL.
| Name | Description |
|---|---|
| eventId | The identifier of an event. It is the notification ID for Title Alert API. |
| eventType | Event name defined. It is fixed to title_alert_notification for Title Alert API. |
| eventDate | The datetime when a notification is sent to the customer. |
| volumeFolio | The ID of the title in the vol/fol format. The customers can subscribe the volumeFolio they want to receive alerts on. |
| customerRef | Customer reference information provided by the customer. |
| startDateTime | This shows the Subscription start datetime for the particular volumeFolio. Customer will only receive alerts on the vol/fol |
| endDateTime | This shows the Subscription end datetime for the particular volumneFolio. |
| notificationId | A unique ID generated when a notification is sent to the customer. Customers can use the ID to audit the particular alert response. |
| subscriptionId | A unique subscription ID generated when a customer subscribes to a volFol. Customers can use the ID to audit the particular subscription. |
| activityType | The type of the activity sent in the notification. The Title Alert API currently supports 2 activity types: a. PRELODGE(Workspace Alert) b. POSTLODGE(Dealing Alert) |
| activityTime | The timestamp when the activity has occurred in the system. |
The eventId, eventType, and eventDate are root level fields while the rest of the fields are nested in the data field. See below for an example request body.
{
"eventId": "64558b39-22e3-421e-b314-3bf67a686ea3",
"eventType": "title_alert_notification",
"eventDate": "2025-01-30T03:20:12.913791+00:00",
"data": {
"notificationId": "64558b39-22e3-421e-b314-3bf67a686ea3",
"subscriptionId": "f7cd88dc-1234-4ffb-8ae8-729b46685cdf",
"volumeFolio": "10000/000",
"customerRef": "internal-tester",
"activityType": "PRELODGE",
"activityTime": "2024-11-15T00:29:49Z"
}
}